Add alpine-ts example #2754
Open
Add alpine-ts example #2754
+1,140
−5
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
|
@niLPotential is attempting to deploy a commit to the Chakra UI Team on Vercel. A member of the Team first needs to authorize it. |
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
📝 Description
Add an example project using Zag as an Alpine.js plugin
⛳️ Current behavior (updates)
none
🚀 New behavior
This PR adds an example vite project simillar to the vanilla-ts example, with modifications around Alpine.js.
The
src/lib/directory exports thenormalizePropsfunction and anAlpineMachineclass.AlpineMachineconsumes the component machine and user props and returns a service.The
src/plugin.tsfile exports ancreateZagPluginfunction, which returns an Alpine.js plugin function corresponding to the given Zag component. It saves the connected api as data, initializes the machine, and reevaluates the api and re-binds the props on effect. Then one can use Zag component in html withx-component-name:partdirectives, and$componentNamemagic.The
pages/directory contains examples in practice, with real time props manipulation like the website.💣 Is this a breaking change (Yes/No):
No
📝 Additional Information
Although I believe this implementation to work, there are some concerns.
Mainly that this might not be the most optimal way to extend Alpine.js.
My understanding of their inner apis is lacking, so there could be an improved version.
Also, I tried some manual testing, but bugs may still happen, especially in components not listed in the example.
I would not consider this stable or be ready as an official package.
Nonetheless, a half-baked example is better than none, so hopefully this is helpful.